revelplayer/com.reveldigital.player.view/[androidJvm]WebView

WebView

open class WebView : WebView, RevelControl, OnCommandListener

A custom android.webkit.WebView implementation that provides additional functionality for displaying web content within the RevelDigital player application.

This class extends the standard android.webkit.WebView and integrates with application-specific components like com.reveldigital.player.api.RevelControl and com.reveldigital.player.api.OnCommandListener. It handles custom configurations based on com.reveldigital.player.api.Module options, manages JavaScript execution, and provides hooks for navigation and callback events.

Key features include:

Configuration of WebView settings (e.g., JavaScript, plugins, user agent, cache mode).
Handling of basic HTTP authentication.
Support for custom asset loading via androidx.webkit.WebViewAssetLoader.
Integration with com.reveldigital.player.connectivity.ConnectivityMonitor to adjust cache settings based on network status.
Providing a com.reveldigital.player.JavascriptInterfaceObject for communication between JavaScript and native Android code.
Management of navigation and callback listeners (com.reveldigital.player.api.OnNavigateListener, com.reveldigital.player.api.OnCallbackListener).
Support for content refresh intervals.
Functionality to print the current web page content (requires API level 19+).

This WebView is typically initialized with a com.reveldigital.player.api.Module object, which dictates its behavior and content (URL, HTML, refresh intervals, etc.).

See also

OnCommandListener

Constructors

constructor(context: Context, module: Module)

Constructs a new WebView with a Context object and a Module object.

Properties

connectivityMonitor

@Inject

open var connectivityMonitor: ConnectivityMonitor

Functions

addOnCallbackListener

open fun addOnCallbackListener(listener: OnCallbackListener)

Adds the OnCallbackListener.

addOnNavigateListener

open fun addOnNavigateListener(listener: OnNavigateListener)

Adds an OnNavigateListener to the WebView.

open fun dispose()

Called when the WebView is no longer needed and should release its resources.

executeJavascript

open fun executeJavascript(script: String)

open fun executeJavascript(script: String, callback: ValueCallback<String>)

Execute the supplied Javascript within the loaded web page.

open fun getName(): String

Gets the unique name assigned to this control.

open fun getOptions(): Iterator<out Option>

Gets an iterator over the configuration s for this control.

open fun getPlaylist(): Playlist

Gets the associated with this control, if any.

open fun getType(): ModuleType

Gets the type of the underlying module or content associated with this control.

open fun getZIndex(): Int

Gets the Z-index (stacking order) of this control.

open fun initialize(module: Module)

Initializes the control with its associated module context.

open fun isAutoStart(): Boolean

Checks if this control is configured to start its operation automatically after #initialize(Module) initialization.

open fun isStarted(): Boolean

Checks if the control is currently in a started or active operational state.

open fun onCommand(name: String, value: String)

Invoked when a command is received by a component this listener is registered with.

@RequiresApi(api = Build.VERSION_CODES.KITKAT)

open fun print()

Prints the currently displayed web page content.

removeOnCallbackListener

open fun removeOnCallbackListener(listener: OnCallbackListener)

Removes the specified OnCallbackListener from the list of listeners.

removeOnNavigateListener

open fun removeOnNavigateListener(listener: OnNavigateListener)

Removes the OnNavigateListener.

open fun setAutoStart(flag: Boolean)

Sets whether this control should start its operation automatically after #initialize(Module) initialization.

open fun start()

Starts or resumes the active operation of this control.

open fun stop()

Stops or pauses the active operation of this control.